跳到主要内容

consultar_solicitacoes

Request

为了简化流程,如果客户希望对之前已查询过的人员使用新的基准日期重新查询,我们提供 /scr/redo 操作。使用此操作的优势在于:如果该人员的授权文件仍然有效,则无需创建新的签名文件¹,查询将立即创建。本请求的 header 和 body 签名格式在此处详细描述。

  • ENDPOINT
    /scr
  • MÉTODO
    GET

QUERY PARAMS

字段类型描述
origin_keystring操作标识密钥。返回与该操作相关的所有查询。
subject_person_typeenum被查询人员类型过滤器。
subject_document_numberstringCPF 或 CNPJ 过滤器,不接受部分匹配。
created_at_start_datestring创建日期范围起始过滤器(格式:YYYY-MM-DD)。
created_at_end_datestring创建日期范围结束过滤器(格式:YYYY-MM-DD)。
consulted_at_start_datestring查询日期范围起始过滤器(格式:YYYY-MM-DD)。
consulted_at_end_datedatetime查询日期范围结束过滤器(格式:YYYY-MM-DD)。
scr_statusenum查询状态过滤器。
pageinteger当前查询的页码。
page_sizeinteger每页结果数量。

枚举值

person_type 枚举值

枚举值翻译
natural自然人
legal法人

scr_status 枚举值

枚举值翻译
created已创建
pending_signature待签名
signed已签名
rejected已拒绝
consulted已查询
error出错
canceled已取消

Response

状态:

200

Response Body
{
"data": [
{
"consent_term": null,
"consulted_at": null,
"created_at": "2020-04-24",
"report_end_date": "2020-03",
"report_start_date": "2020-01",
"result_document": null,
"origin_key": "db5d1627-841f-4ddd-97f8-925557531718",
"scr_status": "pending_signature",
"signers": [
{
"name": "Diretor 1",
"document_number": "03030230074",
"email": "diretor1@email.com"
},
{
"name": "Diretor 2",
"document_number": "03030230074",
"email": "diretor2@email.com"
}
],
"subject_document_number": "05305188000108",
"subject_name": "Padaria do Joao Ninguem",
"subject_person_type": "legal"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 100,
"total_pages": 1,
"total_rows": 55
}
}

状态:

400

body.json
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}